<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT>    // Copyright 2007 Waterken Inc. under the terms of the MIT X license<a name="line.1"></a>
<FONT color="green">002</FONT>    // found at http://www.opensource.org/licenses/mit-license.html<a name="line.2"></a>
<FONT color="green">003</FONT>    package org.waterken.serial;<a name="line.3"></a>
<FONT color="green">004</FONT>    <a name="line.4"></a>
<FONT color="green">005</FONT>    import org.ref_send.promise.Promise;<a name="line.5"></a>
<FONT color="green">006</FONT>    <a name="line.6"></a>
<FONT color="green">007</FONT>    /**<a name="line.7"></a>
<FONT color="green">008</FONT>     * An infinite series of elements.<a name="line.8"></a>
<FONT color="green">009</FONT>     * &lt;p&gt;<a name="line.9"></a>
<FONT color="green">010</FONT>     * A series is a FIFO list of values where the values can be removed from the<a name="line.10"></a>
<FONT color="green">011</FONT>     * list before they have been added. An invocation of {@link #consume} returns<a name="line.11"></a>
<FONT color="green">012</FONT>     * a promise for what will be the next element in the list, once it is added, at<a name="line.12"></a>
<FONT color="green">013</FONT>     * which time it will already have been removed. ;)<a name="line.13"></a>
<FONT color="green">014</FONT>     * &lt;/p&gt;<a name="line.14"></a>
<FONT color="green">015</FONT>     * @param &lt;T&gt;   value type<a name="line.15"></a>
<FONT color="green">016</FONT>     */<a name="line.16"></a>
<FONT color="green">017</FONT>    public interface<a name="line.17"></a>
<FONT color="green">018</FONT>    Series&lt;T&gt; extends Iterable&lt;Promise&lt;T&gt;&gt; {<a name="line.18"></a>
<FONT color="green">019</FONT>        <a name="line.19"></a>
<FONT color="green">020</FONT>        /**<a name="line.20"></a>
<FONT color="green">021</FONT>         * Gets the front element.<a name="line.21"></a>
<FONT color="green">022</FONT>         */<a name="line.22"></a>
<FONT color="green">023</FONT>        Element&lt;T&gt; getFront();<a name="line.23"></a>
<FONT color="green">024</FONT>    <a name="line.24"></a>
<FONT color="green">025</FONT>        /**<a name="line.25"></a>
<FONT color="green">026</FONT>         * Appends a value to the end of the series.<a name="line.26"></a>
<FONT color="green">027</FONT>         * @param value value to append<a name="line.27"></a>
<FONT color="green">028</FONT>         */<a name="line.28"></a>
<FONT color="green">029</FONT>        void produce(Promise&lt;T&gt; value);<a name="line.29"></a>
<FONT color="green">030</FONT>        <a name="line.30"></a>
<FONT color="green">031</FONT>        /**<a name="line.31"></a>
<FONT color="green">032</FONT>         * Removes the first element in the series.<a name="line.32"></a>
<FONT color="green">033</FONT>         * @return value of the removed element<a name="line.33"></a>
<FONT color="green">034</FONT>         */<a name="line.34"></a>
<FONT color="green">035</FONT>        Promise&lt;T&gt; consume();<a name="line.35"></a>
<FONT color="green">036</FONT>    }<a name="line.36"></a>




























































</PRE>
</BODY>
</HTML>
